/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Skyflow from "../../../../index";
/**
 * @example
 *     {
 *         vault_id: "f4b3b3b33b3b3b3b3b3b3b3b3b3b3b3b",
 *         text: "My name is John Doe, and my email is johndoe@acme.com."
 *     }
 *
 * @example
 *     {
 *         vault_id: "f4b3b3b33b3b3b3b3b3b3b3b3b3b3b3b",
 *         text: "S: 62yo female here for first visit. No concerns today. Her FP (Dr. Benyamin) is retiring soon. Up to date on pap, mammo, labs, BMD. On the waitlist for colonoscopy. Past Medical and Surgical hx: nil. Meds: nil. Allergies: Pn. Family and Social hx: see CPP. O: Temp 35.2;BP 145-73; HR 58. Appears well. A: First visit. P: CPP updated. RTC prn. A007. First visit. Type Name: Clinical Note"
 *     }
 *
 * @example
 *     {
 *         vault_id: "f4b3b3b33b3b3b3b3b3b3b3b3b3b3b3b",
 *         text: "My name is John Doe, and my email is johndoe@acme.com.",
 *         entity_types: ["name", "email_address"],
 *         token_type: {
 *             default: "entity_only"
 *         }
 *     }
 *
 * @example
 *     {
 *         vault_id: "VAULT_ID",
 *         text: "My name is John Doe, and my email is johndoe@acme.com.",
 *         token_type: {
 *             default: "vault_token"
 *         }
 *     }
 *
 * @example
 *     {
 *         vault_id: "VAULT_ID",
 *         text: "My name is John Doe, and my email is johndoe@acme.com."
 *     }
 *
 * @example
 *     {
 *         vault_id: "VAULT_ID",
 *         text: "My name is John, and my email is johndoe@acme.com.",
 *         entity_types: ["name", "email_address"],
 *         token_type: {
 *             default: "entity_only"
 *         },
 *         allow_regex: ["John"],
 *         transformations: {
 *             shift_dates: {
 *                 max_days: 5,
 *                 min_days: 1,
 *                 entity_types: ["date"]
 *             }
 *         }
 *     }
 */
export interface DeidentifyStringRequest {
    vault_id: Skyflow.VaultId;
    /** String to de-identify. */
    text: string;
    configuration_id?: Skyflow.ConfigurationId;
    entity_types?: Skyflow.EntityTypes;
    token_type?: Skyflow.TokenType;
    allow_regex?: Skyflow.AllowRegex;
    restrict_regex?: Skyflow.RestrictRegex;
    transformations?: Skyflow.Transformations;
}